Scenario #1103: Replace Contact Data

Given Properties

name	value
partnerName	Test AG
newContactCaption	Test AG - China
newPostalAddress	“firm”: “Test AG”, “name”: “Fi Zhong-Kha”, “building”: “Thi Chi Koh Building”, “street”: “No.2 Commercial Second Street”, “district”: “Niushan Wei Wu”, “city”: “Dongguan City”, “province”: “Guangdong Province”, “country”: “China”
newOfficePhoneNumber	++15 999 654321
newEmailAddress	norden@test-ag.example.org

partnerRelationUuid

GET /api/hs/office/relations?relationType=PARTNER&personData=Test+AG
=> status: 200 OK 
[ {
  "uuid" : "a4914399-27dc-4094-bf76-d6230d4f8373",
  "anchor" : {
    "uuid" : "c6575205-1480-4b70-a30b-d0c5a1d7cc99", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "f8f6ad7e-53d2-4cf0-9cb9-30ca2767c599", // Person: Test AG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Test AG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "e4866b08-4914-4409-9abe-ca187634729d", // Contact: Test AG - Hamburg
    "caption" : "Test AG - Hamburg",
    "postalAddress" : {
      "city" : "Hamburg",
      "firm" : "Test AG",
      "street" : "Shanghai-Allee 1",
      "country" : "Germany",
      "zipcode" : "20123"
    },
    "emailAddresses" : {
      "main" : "hamburg@test-ag.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 40 654321-0"
    }
  }
} ]

In production, data this query could result in multiple outputs. In that case, you have to find out which is the right one.

Contact: Test AG - China

POST /api/hs/office/contacts
{
  "caption" : "Test AG - China",
  "postalAddress" : {
    "firm" : "Test AG",
    "name" : "Fi Zhong-Kha",
    "building" : "Thi Chi Koh Building",
    "street" : "No.2 Commercial Second Street",
    "district" : "Niushan Wei Wu",
    "city" : "Dongguan City",
    "province" : "Guangdong Province",
    "country" : "China"
  },
  "phoneNumbers" : {
    "phone" : "++15 999 654321"
  },
  "emailAddresses" : {
    "main" : "norden@test-ag.example.org"
  }
}
=> status: 201 CREATED 22c8432b-6fc1-44b4-a977-e1d00327b323

Please check first if that contact already exists, if so, use it’s UUID below.

If any postalAddress sub-properties besides those specified in the API (currently firm, name, co, street, zipcode, city, country) its values might not appear in external systems.

Replace the Contact-Reference in the Partner-Relation

PATCH /api/hs/office/relations/a4914399-27dc-4094-bf76-d6230d4f8373 // partnerRelationUuid
{
  "contact.uuid" : "22c8432b-6fc1-44b4-a977-e1d00327b323" // Contact: Test AG - China
}
=> status: 200 OK 

Verify if the Contact-Relation Got Replaced in the Partner-Relation

GET /api/hs/office/relations?relationType=PARTNER&personData=Test+AG
=> status: 200 OK 
[ {
  "uuid" : "a4914399-27dc-4094-bf76-d6230d4f8373", // partnerRelationUuid
  "anchor" : {
    "uuid" : "c6575205-1480-4b70-a30b-d0c5a1d7cc99", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "f8f6ad7e-53d2-4cf0-9cb9-30ca2767c599", // Person: Test AG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Test AG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "22c8432b-6fc1-44b4-a977-e1d00327b323", // Contact: Test AG - China
    "caption" : "Test AG - China",
    "postalAddress" : {
      "city" : "Dongguan City",
      "firm" : "Test AG",
      "name" : "Fi Zhong-Kha",
      "street" : "No.2 Commercial Second Street",
      "country" : "China",
      "building" : "Thi Chi Koh Building",
      "district" : "Niushan Wei Wu",
      "province" : "Guangdong Province"
    },
    "emailAddresses" : {
      "main" : "norden@test-ag.example.org"
    },
    "phoneNumbers" : {
      "phone" : "++15 999 654321"
    }
  }
} ]

---

generated on 03-10-2025 12:07:40 for branch master